IMAP-PART 02

Downloading and exploring microbiome sample metadata from SRA Database

Fostering Reproducible Microbiome data Analysis with Snakemake workflow

Microbiome Sample metadata

What is metadata?

• Metadata is a set of data that describes and provides information about other data. It is commonly defined as data about data.
• Sample metadata described here refers to the description and context of the individual sample collected for a specific microbiome study.

Metadata structure

• Metadata collected at different stages are typically organized in an Excel or Google spreadsheet where:
  • The metadata table columns represent the properties of the samples.
  • The table rows contain information associated with the samples.
  • Typically, the first column of sample metadata is Sample ID, which designates the key associated to individual sample
  • Sampl ID must be unique.

Embedded metadata

• In most cases, you will find the metadata detached from the experimental data.
• Embedded metadata integrates the experimental data especially for graphics.
• Major microbiome analysis platforms require sample metadata, commonly referred to as mapping file when performing downstream analysis.

Snakemake workflow for metadata acquisition

. A detailed interactive snakemake report is available here.

Downloading NCBI-SRA metadata

Different methods exist for downloading sample metadata deposited in the Sequence Read Archive (SRA) or the European Nucleotide Archive (ENA). Each process yields slightly different information, so it is an ideal habit to explore which method gives you what suits you best. For demo: We will explore more on sample metadata retrieved from four randomly selected microbiome BioProjects, including:

1. PRJNA477349: 16S rRNA from bushmeat samples collected from Tanzania Metagenome (Multispecies).
2. PRJNA802976: Changes to Gut Microbiota following Systemic Antibiotic Administration in Infants (Multispecies).
3. PRJNA322554: The Early Infant Gut Microbiome Varies In Association with a Maternal High-fat Diet (Multispecies).
4. PRJNA937707: Microbiome associated with spotting disease in the purple sea urchin (Multispecies).
5. PRJNA589182: 16S rDNA gene sequencing of the phyllosphere endophytic bacterial communities colonizing wild (Multispecies).

Manually via SRA Run Selector

We can manually retrieve metadata from the SRA database via the SRA Run Selector.

• Note that the SRA filename for metadata is automatically named SraRunTable.txt.
• Users can change the default TXT extension to like CSV if preferred.
• In our demo, we will use CSV to save the metadata file in the data/metadata/ folder.

Example screen shot of SRA Run Selector for metadata associated with the NCBI-SRA bioproject number PRJNA477349

Computationally via Entrez Direct

#!/bin/bash

esearch -db sra -query 'PRJNA477349[bioproject]' | efetch -format runinfo >data/metadata/runinfo_PRJNA477349_metadata.csv;
esearch -db sra -query 'PRJNA802976[bioproject]' | efetch -format runinfo >data/metadata/runinfo_PRJNA802976_metadata.csv;
esearch -db sra -query 'PRJNA322554[bioproject]' | efetch -format runinfo >data/metadata/runinfo_PRJNA322554_metadata.csv;
esearch -db sra -query 'PRJNA937707[bioproject]' | efetch -format runinfo >data/metadata/runinfo_PRJNA937707_metadata.csv;
esearch -db sra -query 'PRJNA589182[bioproject]' | efetch -format runinfo >data/metadata/runinfo_PRJNA589182_metadata.csv;

Computationally using pysradb

Create pysradb environment

The pysradb tool can obtain metadata from SRA and ENA. Here we will create an independent environment and install pysradb. We can delete this env when no longer needed. To learn more click here.

• First, we create a pysradb environment and install the pysradb tool.
• Then we use pysradb to download the SRA metadata on CLI.

conda activate base
conda create -c bioconda -n pysradb PYTHON=3 pysradb

Using a bash script

#!/bin/bash
# Shell script: workflow/scripts/pysradb_sra_metadata.sh

pysradb metadata PRJNA477349 --detailed >data/metadata/PRJNA477349_pysradb.csv
pysradb metadata PRJNA802976 --detailed >data/metadata/PRJNA802976_pysradb.csv
pysradb metadata PRJNA322554 --detailed >data/metadata/PRJNA322554_pysradb.csv
pysradb metadata PRJNA937707 --detailed >data/metadata/PRJNA937707_pysradb.csv
pysradb metadata PRJNA589182 --detailed >data/metadata/PRJNA589182_pysradb.csv

Using a python script

# Python script: workflow/scripts/pysradb_sra_metadata.py

import os
import sys
import csv
import pandas as pd

from pysradb.sraweb import SRAweb

db = SRAweb()
df = db.sra_metadata('PRJNA477349', detailed=True)
df.to_csv('data/metadata/PRJNA477349_pysradb_metadata.csv', index=False)

db = SRAweb()
df = db.sra_metadata('PRJNA802976', detailed=True)
df.to_csv('data/metadata/PRJNA802976_pysradb_metadata.csv', index=False)

db = SRAweb()
df = db.sra_metadata('PRJNA322554', detailed=True)
df.to_csv('data/metadata/PRJNA322554_pysradb_metadata.csv', index=False)

db = SRAweb()
df = db.sra_metadata('PRJNA937707', detailed=True)
df.to_csv('data/metadata/PRJNA937707_pysradb_metadata.csv', index=False)

db = SRAweb()
df = db.sra_metadata('PRJNA589182', detailed=True)
df.to_csv('data/metadata/PRJNA589182_pysradb_metadata.csv', index=False)

I sometimes experience ConnectionError when using python method. Try a different method if that happens.

Querying SRA or ENA with a keyword

Using keywords to search any extensive database helps filter user-specified information, such as certain disease-related studies.

#!/bin/bash

pysradb search --db sra -q Amplicon --max 100 >sra_amplicon_studies.csv

pysradb search --db ena -q Amplicon --max 100 >ena_amplicon_studies.csv

Next, we will explore downloaded metadata to learn more about the various features represented.

Exploring sample metadata

Read size

The size of the reads can tell us how big is the dataset and can help to estimate the computational needs.

Top five smallest project by read size

# A tibble: 5 × 3
  run        bioproject   bases
  <chr>      <chr>        <dbl>
1 SRR3725509 PRJNA322554    581
2 SRR3725412 PRJNA322554 100541
3 SRR3725402 PRJNA322554 117824
4 SRR3725434 PRJNA322554 132240
5 SRR3725457 PRJNA322554 136774

Top five highest project by read size

# A tibble: 5 × 3
  run         bioproject      bases
  <chr>       <chr>           <dbl>
1 SRR10245303 PRJNA477349 434919320
2 SRR10245294 PRJNA477349 382616209
3 SRR10245352 PRJNA477349 316807915
4 SRR10245293 PRJNA477349 274398756
5 SRR10245330 PRJNA477349 265408834

Compare read size by BioProject

Compare read size by variables

Explore project sampling points

Dropping pins on the map is posible if you have coordinate data, the latitudes and longitude of collection points. By hovering on the pin you will be able to see the corresponding project, when viewed interactively.

---

Related work

Repo	Description	Status
IMAP-PART 01	Installing software to get started with microbiome data analysis with Snakemake workflows	In-progress
IMAP-PART 02	Downloading and exploring microbiome sample metadata from SRA Database	In-progress
IMAP-PART 03	Downloading and filtering microbiome sequencing data from SRA database	In-progress
IMAP-PART 04	Quality Control of Microbiome Next Generation Sequencing Reads	In-progress
IMAP-PART 05	Bioinformatics & classification of preprocessed microbiome sequencing data	In-progress
IMAP-PART 06		In-progress
IMAP-PART 07		In-progress
IMAP-PART 08		In-progress

Citation

Please consider citing the iMAP article^[1] if you find any part of the IMAP practical user guides helpful in your microbiome data analysis.

References

[1]

Buza, T. M., Tonui, T., Stomeo, F., Tiambo, C., Katani, R., Schilling, M., … Kapur, V. (2019). iMAP: An integrated bioinformatics and visualization pipeline for microbiome data analysis. BMC Bioinformatics, 20. https://doi.org/10.1186/S12859-019-2965-4

---

Appendix

Project main tree

.
├── LICENSE
├── README.md
├── Rplots.pdf
├── config
│   ├── config.yaml
│   ├── samples.csv
│   ├── samples.tsv
│   ├── units.csv
│   └── units.tsv
├── dag.pdf
├── dags
│   ├── rulegraph.png
│   └── rulegraph.svg
├── data
│   └── metadata
├── ena_amplicon_studies.csv
├── images
│   ├── PRJNA477349_read_size.png
│   ├── PRJNA477349_read_size.svg
│   ├── analysis_creation_time.svg
│   ├── analysis_statistics.svg
│   ├── bkgd.png
│   ├── geeks.png
│   ├── gpsfiles
│   ├── metadata.png
│   ├── read_size.png
│   ├── read_size.svg
│   ├── rule_runtime_date.png
│   ├── sample_gps.png
│   ├── smk_static_report.png
│   ├── smkreport
│   └── sra_run_selector.png
├── imap-sample-metadata.Rproj
├── index.Rmd
├── library
│   ├── apa.csl
│   ├── imap.bib
│   └── references.bib
├── report.html
├── resources
├── results
│   ├── project_tree.txt
│   ├── read_size_asc.csv
│   └── read_size_desc.csv
├── smk.css
├── sra_amplicon_studies.csv
├── styles.css
└── workflow
    ├── Snakefile
    ├── envs
    ├── report
    ├── rules
    ├── schemas
    └── scripts

16 directories, 38 files

Static snakemake report

We can view the interactive snakemake HTML report by opening the report.html using any compatible browser. You will be able to explore the workflow and the associated statistics. You can close the left bar to get a more expansive display view. We can use a styleshee like so: snakemake --report report.html --report-stylesheet smk.css.

Troubleshooting of FAQs

1. Question
Answer
2. Question
Answer

---

Last updated on March 18, 2023.
Github_Repo: https://github.com/tmbuza/imap-sample-metadata.
Repo compiled and maintained by: Teresia Mrema-Buza.